\rcube_result_set

Roundcube result set class

Representing an address directory result set. Implements Iterator and can thus be used in foreach() loops.

Summary

Methods
Properties
Constants
__construct()
add()
iterate()
first()
seek()
offsetSet()
offsetExists()
offsetUnset()
offsetGet()
rewind()
current()
key()
next()
valid()
$count
$first
$searchonly
$records
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$current
N/A

Properties

$count

$count : int

Type

int — The number of total records. Note that when only a subset of records is requested, this number may be higher than the number of data records in this result set.

$first

$first : int

Type

int — When a subset of the total records is requested, $first gives the index into the total record set from that the data records in this result set start. This is normally a multiple of the user-configured page size.

$searchonly

$searchonly : bool

Type

bool — True if the results are from an addressbook that does not support listing all records but requires the search function to be used.

$records

$records : array

Type

array — The data records of the result set. May be a subset of the total records, e.g. for one page.

$current

$current

Methods

__construct()

__construct(mixed  $count, mixed  $first) : mixed

Parameters

mixed $count
mixed $first

Returns

mixed —

add()

add(mixed  $rec) : mixed

Parameters

mixed $rec

Returns

mixed —

iterate()

iterate() : mixed

Returns

mixed —

first()

first() : mixed

Returns

mixed —

seek()

seek(mixed  $i) : mixed

Parameters

mixed $i

Returns

mixed —

offsetSet()

offsetSet(mixed  $offset, mixed  $value) : mixed

Parameters

mixed $offset
mixed $value

Returns

mixed —

offsetExists()

offsetExists(mixed  $offset) : mixed

Parameters

mixed $offset

Returns

mixed —

offsetUnset()

offsetUnset(mixed  $offset) : mixed

Parameters

mixed $offset

Returns

mixed —

offsetGet()

offsetGet(mixed  $offset) : mixed

Parameters

mixed $offset

Returns

mixed —

rewind()

rewind() : mixed

Returns

mixed —

current()

current() : mixed

Returns

mixed —

key()

key() : mixed

Returns

mixed —

next()

next() : mixed

Returns

mixed —

valid()

valid() : mixed

Returns

mixed —